package com.yanggu.common.operatorlog;


import java.lang.annotation.*;

/**
 * 操作日志注解
 */
@Documented
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface OperateLog {

    /**
     * 接口名称，不能重复
     */
    String name();

    /**
     * 操作类型
     */
    OperateTypeEnum operateType();

    /**
     * 是否保存请求的参数
     */
    boolean isSaveRequestData() default true;

    /**
     * 是否保存响应的参数
     */
    boolean isSaveResponseData() default true;

    /**
     * 可以自定义具体的操作内容，默认为空
     * <p>自定义类实现OperationFunction接口，返回具体操作内容</p>
     */
    Class<? extends OperationFunction> function() default DefaultOperationFunctionImpl.class;

    /**
     * 排除指定的请求参数。支持beanPath的方式，删除属性。例如person.friend[5].name
     */
    String[] excludeRequestParamNames() default {};

    /**
     * 排除指定的响应参数。支持beanPath的方式，删除属性。例如person.friend[5].name
     */
    String[] excludeResponseFieldNames() default {};

}
